<!DOCTYPE html>

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RaxanPlugin - Raxan User Guide</title>
    <link href="../raxan/ui/css/master.css" rel="stylesheet" type="text/css" />
    <!--[if lt IE 8]> <link rel="stylesheet" href="../raxan/ui/css/master.ie.css" type="text/css"><![endif]-->
    <link href="../raxan/ui/css/default/theme.css" rel="stylesheet" type="text/css" />
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        <!--
        hljs.initHighlightingOnLoad('javascript','html','php','css');
        //-->
    </script>
    <!--[if lt IE 7]>
        <style type="text/css"> form input.textbox { height: 26px; }</style>
    <![endif]-->
</head>

<body>
    <div class="container">
        <div id="header" class="rax-header-pal rax-metalic">
            <h2 class="ltm bottom c14">Raxan User Guide</h2>
            <ul>
                <li><a href="../../index.html">Home</a></li>
                <li><a href="index.html">Overview</a></li>
                <li><a href="features.html">Features</a></li>
                <li><a href="table-of-contents.html" title="Table of Content">Contents</a></li>
                <li><a href="../examples">Examples</a></li>
            </ul>
            <ul class="search">
                <li>
                    <form class="tpm c9" name="form1" action="../tools/search.php" method="get">
                        <input class="c6 textbox round left" placeholder="Search" type="text" name="q" value="" title="Search User Guide"  />
                        <input class="c2 button round left ltm" type="submit" value="Go" />
                    </form>
                </li>
            </ul>

        </div>
        <hr class="space"/>
        <div class="master-content-wrapper">
            <div class="container prepend-top c48 master-content"><div class="container c45">

    <h2 class="class-name">Class RaxanPlugin</h2>

    <a name="sec-description"></a>
    <div class="rax-box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
                            <span class="disabled">Description</span> |
                                                                        <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                           
                                </div>
        <div class="rax-box bmm-body">
                        <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Abstract Class for creating plugins</p>
    <ul class="tags">
                <li><span class="field">abstract:</span> </li>
            </ul>
            <p class="notes">
                Located in <span class="field">/raxan.php</span> (line <span class="field">56</span>)
            </p>

            
            <pre></pre>

                    </div>
    </div>

    
    
            <a name="sec-var-summary"></a>
        <div class="rax-box bmm">
            <div class="box-title">Variable Summary</span></div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
                                    | 
                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                               
                                            </div>
            <div class="rax-box bmm-body">
                <div class="var-summary">
                                                            <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$author" title="details" class="var-name">$author</a>
                    </div>
                                                                                <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$description" title="details" class="var-name">$description</a>
                    </div>
                                                                                                                        <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$lastClassName" title="details" class="var-name">$lastClassName</a>
                    </div>
                                                                                <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$name" title="details" class="var-name">$name</a>
                    </div>
                                                                                <div class="var-title">
                        static <span class="var-type">mixed</span>
                        <a href="#$shared" title="details" class="var-name">$shared</a>
                    </div>
                                                                                                                                                                                    <div class="var-title">
                        <span class="var-type">mixed</span>
                        <a href="#$events" title="details" class="var-name">$events</a>
                    </div>
                                                                                                                                                                                </div>
            </div>
        </div>
    
            <a name="sec-method-summary"></a>
        <div class="rax-box bmm">
            <div class="box-title">Method Summary</span></div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                     
                    |
                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
            </div>
            <div class="rax-box bmm-body">         
                <div class="method-summary">
                                                                                                    <div class="method-definition">
                        static                             <span class="method-result">string</span>
                                                <a href="#getLastClassName" title="details" class="method-name">getLastClassName</a>
                                                ()
                                            </div>
                                                                                <div class="method-definition">
                        static                             <span class="method-result">mixed</span>
                                                <a href="#getLastInstance" title="details" class="method-name">getLastInstance</a>
                                                ()
                                            </div>
                                                                                <div class="method-definition">
                        static                             <span class="method-result">void</span>
                                                <a href="#instance" title="details" class="method-name">instance</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$class</span>)
                                            </div>
                                                                                
                                                            <div class="method-definition">
                                                    <span class="method-result">RaxanPlugin</span>
                                                <a href="#__construct" title="details" class="method-name">__construct</a>
                                                ()
                                            </div>
                                                                                                                                                                                                        <div class="method-definition">
                                                    <span class="method-result">void</span>
                                                <a href="#raiseEvent" title="details" class="method-name">raiseEvent</a>
                                                    (<span class="var-type"></span>&nbsp;<span class="var-name">$event</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
                                            </div>
                                            </div>
            </div>
        </div>      
    
            <a name="sec-vars"></a>
        <div class="rax-box bmm">
            <div class="box-title">Variables</div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
                           

                                                    | 
                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
                               
                            </div>
            <div class="rax-box bmm-body">
                <a name="var$author" id="$author"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$author</span>
             = <span class="var-default"> &quot;Author's name&quot;</span>            (line <span class="line-number">61</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
   
    
        
       

</div>
<a name="var$description" id="$description"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$description</span>
             = <span class="var-default"> &quot;Plugin description&quot;</span>            (line <span class="line-number">60</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
   
    
        
       

</div>
<a name="var$lastClassName" id="$lastClassName"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$lastClassName</span>
                        (line <span class="line-number">63</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$name" id="$name"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$name</span>
             = <span class="var-default"> 'Plugin Name'</span>            (line <span class="line-number">59</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
   
    
        
       

</div>
<a name="var$shared" id="$shared"><!-- --></a>
<div class="oddrow">

    <div class="var-header">
        <span class="var-title">
            static <span class="var-type">mixed</span>
            <span class="var-name">$shared</span>
             = <span class="var-default">array()</span>            (line <span class="line-number">64</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
<a name="var$events" id="$events"><!-- --></a>
<div class="evenrow">

    <div class="var-header">
        <span class="var-title">
            <span class="var-type">mixed</span>
            <span class="var-name">$events</span>
                        (line <span class="line-number">66</span>)
        </span>
    </div>

    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> protected</li>
            </ul>
   
    
        
       

</div>
                           
            </div>
        </div>
    
            <a name="sec-methods"></a>
        <div class="rax-box bmm">
            <div class="box-title">Methods</div>
            <div class="nav-bar">
                <a href="#sec-description">Description</a> |
                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
                           
            </div>
            <div class="rax-box bmm-body">
                <a name='method_detail'></a>
<a name="methodgetLastClassName" id="getLastClassName"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">static getLastClassName</span> (line <span class="line-number">94</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used internally - Returns the last registered plugin class name</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        static <span class="method-result">string</span>
        <span class="method-name">
            getLastClassName
        </span>
                ()
            </div>
    
        
            
    </div>
<a name="methodgetLastInstance" id="getLastInstance"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">static getLastInstance</span> (line <span class="line-number">102</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used internally - Returns the last registered plugin instance</p>
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        static <span class="method-result">mixed</span>
        <span class="method-name">
            getLastInstance
        </span>
                ()
            </div>
    
        
            
    </div>
<a name="methodinstance" id="instance"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">static instance</span> (line <span class="line-number">83</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        static <span class="method-result">void</span>
        <span class="method-name">
            instance
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$class</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$class</span>            </li>
                </ul>
        
            
    </div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
    
    <div class="method-header">
        <span class="method-title">Constructor __construct</span> (line <span class="line-number">68</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">RaxanPlugin</span>
        <span class="method-name">
            __construct
        </span>
                ()
            </div>
    
        
            
    </div>
<a name="methodraiseEvent" id="raiseEvent"><!-- --></a>
<div class="oddrow">
    
    <div class="method-header">
        <span class="method-title">raiseEvent</span> (line <span class="line-number">78</span>)
    </div> 
    
    <!-- ========== Info from phpDoc block ========= -->
    <ul class="tags">
                <li><span class="field">access:</span> public</li>
            </ul>
    
    <div class="method-signature">
        <span class="method-result">void</span>
        <span class="method-name">
            raiseEvent
        </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$event</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
            </div>
    
            <ul class="parameters">
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$event</span>            </li>
                    <li>
                <span class="var-type"></span>
                <span class="var-name">$args</span>            </li>
                </ul>
        
            
    </div>
                           
            </div>
        </div>
    
    </div>
</div>
            
            <div id="footer" class="container c48 rax-active-pal round rax-glossy">
                <ul class="clearfix">
                    <li><a href="index.html">Overview</a></li>
                    <li><a href="features.html">Features</a></li>
                    <li><a href="new-features.html">What's new</a></li>
                    <li><a href="table-of-contents.html" title="Table of Content">Contents</a></li>
                    <li><a href="../examples">Examples</a></li>
                </ul>
            </div>
        </div>
    </div>
</body>

</html>

